//
// Copyright 2018 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//

#ifndef PXR_BASE_TRACE_JSON_SERIALIZATION_H
#define PXR_BASE_TRACE_JSON_SERIALIZATION_H

#include "pxr/pxr.h"
#include "pxr/base/trace/collection.h"

PXR_NAMESPACE_OPEN_SCOPE

class JsValue;
class JsWriter;

///////////////////////////////////////////////////////////////////////////////
/// \class Trace_JSONSerialization
///
/// This class contains methods to read and write TraceCollections in JSON 
/// format.  This JSON format for a TraceCollection is an extension of the
/// Chrome Tracing format. 
class Trace_JSONSerialization {
public:
    /// Write a JSON representation of \p collections.
    static bool WriteCollectionsToJSON(JsWriter& js,
        const std::vector<std::shared_ptr<TraceCollection>>& collections);

    /// Creates a TraceCollection from a JSON value if possible.
    static std::unique_ptr<TraceCollection> CollectionFromJSON(const JsValue&);
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif // PXR_BASE_TRACE_JSON_SERIALIZATION_H
